home *** CD-ROM | disk | FTP | other *** search
/ Aminet 4 / Aminet 4 - November 1994.iso / aminet / comm / fido / fidomon10.lha / FidoMon.doc < prev    next >
Text File  |  1994-09-12  |  21KB  |  469 lines
  1.  
  2.  
  3.  
  4.                             FidoMon Version 1.0
  5.                Copyright September, 1994 by Elton VonCannon
  6.  
  7.  
  8.  
  9. ---------------------------------------------------------------------------
  10.                                Introduction:
  11. ---------------------------------------------------------------------------
  12.  
  13. FidoMon   provides  a  real-time  display  of  TrapDoor's  inbound/outbound
  14. directories.   It  provides  a  simple mechanism to change NetMail and Flow
  15. file  status, and it can execute a user defined polling script based on the
  16. address of a selected file.  It also provides FidoNet file type and address
  17. information  at a glance, and even more information is often available with
  18. a  few clicks of a mouse button.  Finally, it provides a mechanism by which
  19. a  user  can edit some of FidoNet's text based files without worrying about
  20. the   carriage  return/line  feed  conversions  that  are  often  otherwise
  21. necessary for FidoNet files.
  22.  
  23.  
  24. ---------------------------------------------------------------------------
  25.                                 Disclaimer:
  26. ---------------------------------------------------------------------------
  27.  
  28. This  software is provided "as is", with no warranty of any kind.  Although
  29. every  effort  has  been made to ensure the quality of this software, in no
  30. event  will  the  author,  Elton VonCannon, be liable for direct, indirect,
  31. incidental  or consequential damages or data loss resulting from its use or
  32. application.   The entire risk as to the results and/or performance of this
  33. software is assumed by you, the user.
  34.  
  35.  
  36. ---------------------------------------------------------------------------
  37.                           Licensing Requirements:
  38. ---------------------------------------------------------------------------
  39.  
  40. This  program  is  copyrighted  material  and  is  not placed in the public
  41. domain.   You  are authorized to use FidoMon for any legal purpose, as long
  42. as you don't modify it in any way.  You may also distribute the archive for
  43. any  non-commercial  purpose  as  long as its contents remain unaltered and
  44. intact.   Any  commercial  distribution,  with the exception of Fred Fish's
  45. disks, requires the explicit permission of the author.
  46.  
  47. FidoMon is being released as shareware.  If you use it, you're requested to
  48. suggest  how to improve it.  Without your support, I will not be making any
  49. enhancements to FidoMon.
  50.  
  51.  
  52. ---------------------------------------------------------------------------
  53.                         Operational Considerations:
  54. ---------------------------------------------------------------------------
  55.  
  56. My  utmost  concern  was to make FidoMon as unobtrusive to the operation of
  57. TrapDoor  as possible.  If FidoMon crashed the system or trashed (or caused
  58. another  application  to  trash) an important file or if it interfered with
  59. TrapDoor's  file  transfers in any way, it would be worthless to myself and
  60. any   potential  users.   Therefore  FidoMon  checks  the  inbound/outbound
  61. directories only about once every 3-4 seconds (sometimes longer).  Patience
  62. is definitely a virtue when file transfers are involved.
  63.  
  64.  
  65. ---------------------------------------------------------------------------
  66.                            System Requirements:
  67. ---------------------------------------------------------------------------
  68.  
  69. AmigaDos version 2.1 or higher.
  70. TrapDoor version 1.83 or higher.
  71. TrapList.library version 4 or higher.
  72. ReqTools.library version 2 or higher.
  73.  
  74. FidoMon  also  requires  an  assignment  to  logical  device  "T:"  for its
  75. temporary  Info and Edit files.  Ideally, this would be made to a directory
  76. somewhere on a fast device (such as RAM:).
  77.  
  78. An external ASCII text editor such as Ed, CED, MicroEmacs, or TurboText.
  79. An external ASCII text reader such as More (or you can just use an editor).
  80. An external dialing program (for calling with TrapDoor).
  81.  
  82. In  addition,  FidoMon  needs the following directories in order to perform
  83. its magic (these are required by TrapDoor anyway but you may need to inform
  84. FidoMon of your paths, if they are other than the defaults listed here):
  85.   Inbound directory  - defaults to "Mail:Inbound/"
  86.   Outbound directory - defaults to "Mail:Outbound/"
  87.   NodeList directory - defaults to "NodeList:"
  88. Note:   If  your  system already uses these defaults for TrapDoor, you need
  89. not specify them to FidoMon.
  90.  
  91.  
  92. ---------------------------------------------------------------------------
  93.                                    Bugs:
  94. ---------------------------------------------------------------------------
  95.  
  96. None known, but...
  97.  
  98.  -  Some  might  consider HiJack mode's behavior when FidoMon exits to be a
  99.     bug,  but  since  this  behavior is  predictable  (and  even documented
  100.     below), I don't.
  101.  
  102.  -  If  FidoMon  opens  a file and TrapDoor immediately tries to delete it,
  103.     TrapDoor  may  not be able to.  This isn't a bug,  this is just the way
  104.     that  a  multitasking filing system works.  My advice is that you don't
  105.     try reading any files at the same time that TrapDoor is sending them.
  106.  
  107.  
  108. ---------------------------------------------------------------------------
  109.                                Installation:
  110. ---------------------------------------------------------------------------
  111.  
  112.  1.  Copy it to a location where you'll be able to find it again.  :-)
  113.  
  114.  2.  If you want FidoMon's window to appear on TrapDoor's screen, you will
  115.      also need to add the following lines to TrapDoor's configuration file
  116.      if they do not already exist:
  117.        a.  Add the line "SCREENMODE PUBLIC".
  118.        b.  Add the line "PUBLICSCREENNAME TrapDoor".  (Note:  Screen names
  119.            other  than  "TrapDoor" are perfectively acceptable also.  Just
  120.            take  note of the  name so that you can tell FidoMon what it is
  121.            later.)
  122.      NOTE: Depending on your operating system version, the screen name may
  123.            be case sensitive.
  124.  
  125.  
  126. ---------------------------------------------------------------------------
  127.                              Starting FidoMon:
  128. ---------------------------------------------------------------------------
  129.  
  130. FidoMon  is  a CLI (or shell) only program.  If you really want to start it
  131. from  Workbench,  you  could  probably create a script and execute it using
  132. IconX, but I haven't tried that.
  133.  
  134. When  you  start FidoMon, you do NOT want to use "RunBack" (or even "Run").
  135. Just type "FidoMon" and hit return and FidoMon will "RunBack" itself.
  136.  
  137. NOTE:   If  you  rename  FidoMon, it will refuse to run correctly.  If this
  138. causes any problems, let me know and I'll address it in a later release.
  139.  
  140.  
  141. If  you  type "FidoMon ?", FidoMon will display a multitude of command line
  142. options  that aren't described here, but you are only required to provide a
  143. public  screen  name in order to get started.  If you already have TrapDoor
  144. running  on a public screen named "TrapDoor" and if your inbound, outbound,
  145. and  NodeList  directory  paths  are "Mail:Inbound/", "Mail:Outbound/", and
  146. "NodeList:"  then  you  won't  have  to  worry  about telling FidoMon about
  147. anything  at  all (you can set up everything else via the program's menus).
  148. Otherwise, FidoMon may ask you for the paths to your inbound, outbound, and
  149. NodeList   directories.    If   the   default   paths   "Mail:Inbound"  and
  150. "Mail:Outbound"  exist,  and  for  some  reason  you aren't using them with
  151. TrapDoor,  you  can  change  them  via  a menu from within FidoMon (or just
  152. specify the correct paths on the command line to begin with).
  153.  
  154. After  FidoMon  is  running, you can save all of its user definable options
  155. (including  its  window  position)  in  a  convenient  configuration  file.
  156. Thereafter,  whenever  FidoMon  is  started,  it will automatically get its
  157. information  from  this configuration file (although you will still be able
  158. to  override any pre-configured options from the command line when you next
  159. start  FidoMon,  or  you can just change them from within the program using
  160. its menus...  The menus are described in a later section).
  161.  
  162. See  the  "The  Configuration Options Menu" section for more information on
  163. customizing your installation.
  164.  
  165.  
  166.  
  167. ---------------------------------------------------------------------------
  168.                                   Usage:
  169. ---------------------------------------------------------------------------
  170.  
  171. When  FidoMon  starts it'll open a window that contains two listviews.  The
  172. top  listview  will list the files in your inbound directory and the bottom
  173. listview will list the files in your outbound directory.  Note that FidoMon
  174. may  not  be able to find the address of every file that is in the outbound
  175. directory.   Hopefully though, it will be able to find the addresses of all
  176. the files that TrapDoor can find an address for.
  177.  
  178. You  can  click on a filename in one of these listviews and get a requester
  179. that will offer you several options.  The options that you are offered will
  180. depend  on  the file's type.  Experimenting is okay (you have the option to
  181. cancel  any  operation  here), but you should probably verify that you have
  182. the  external  dialer, editor and viewer installed correctly.  Note that if
  183. you  click on "Info" and nothing happens, then you probably need to correct
  184. your  external  text  viewer's  configuration  string (see the menu section
  185. below  for  more  information  on  how to configure the individual external
  186. commands).  The same is true for "Edit" and "Poll".
  187.  
  188.  
  189.  
  190.                                    Info
  191.  
  192. When  you  select  "Info",  FidoMon will create a temporary file in T:  and
  193. attempt  to  display  it  using  your  external  viewer.   If everything is
  194. successful,  you should see a report with some additional information about
  195. the file that you selected.
  196.  
  197.                                    Edit
  198.  
  199. When  you select "Edit", a temporary file will be created in T:.  This file
  200. will  have  the  carriage  returns  removed  and  will be the file that you
  201. actually  edit.   After  the  temporary file is created, your external text
  202. editor  will  be started.  After you finish editing (if you click "Save" in
  203. the  requester), carriage returns will be added and the file will be copied
  204. to  its  final  destination.  In other words, FidoMon automatically handles
  205. the carriage return conversions that FidoNet files often require...  and it
  206. does  it transparently to your chosen editor.  Currently, you can only edit
  207. .tic, .req and flow files.
  208.  
  209.                                    Poll
  210.  
  211. When  you select "Poll", FidoMon will use the file's address as an argument
  212. to your external dialer command.  In other words, if you select a file that
  213. has an address of "1:3648/101" and you have your external dialer configured
  214. as "run rx rexx:Call %s", then FidoMon will attempt to execute the command:
  215. "run  rx  rexx:Call  1:3648/101" as if you had typed it at a shell.  Notice
  216. that  the  default external dialer string opens a CON:  window for its I/O.
  217. This  is  necessary  if  you wish to ever send something like a CTRL-C to a
  218. dialing program that has been started by FidoMon.
  219.  
  220.                                   Status
  221.  
  222. When  you  select  "Status"  you will be shown a requester for changing the
  223. file's  status.  Note that this sets the file's FidoNet routing status (ie:
  224. Direct, Crash, Hold, etc), not the file's protection bits.
  225.  
  226.  
  227.  
  228. ---------------------------------------------------------------------------
  229.                              The Project Menu
  230. ---------------------------------------------------------------------------
  231.  
  232.                                Save Settings
  233.  
  234. Selecting  the  "Save  Steeings"  menu  item  will  save  FidoMon's current
  235. configuration  to  a  file  in  FidoMon's  directory  named  "FidoMon.cfg".
  236. Therefore,  once  you  set  FidoMon up the way you want it, just select the
  237. "Save  Settings" item and FidoMon will always start with those same options
  238. selected.   All  of  the  options that you can set from the command line or
  239. from  within the program (including FidoMon's window position) are saved in
  240. the configuration file.
  241.  
  242.  
  243.                                    About
  244.  
  245. Displays some information about FidoMon.
  246.  
  247.  
  248.                                    Quit
  249.  
  250. Terminates  FidoMon  (as if you couldn't figure that out for yourself).  If
  251. you have changed any of FidoMon's settings (other than its window position)
  252. from  within  the  program,  FidoMon  will  ask you if you want to save the
  253. settings before exiting.  However, if you had altered FidoMon's settings at
  254. startup  via  the  command  line  options,  FidoMon  will not know that its
  255. settings have been changed.
  256.  
  257.  
  258. ---------------------------------------------------------------------------
  259.                       The Displayable File Types Menu
  260. ---------------------------------------------------------------------------
  261.  
  262.  
  263. Since  FidoMon  has relatively small display areas, you may not always want
  264. to see all the types of files that it can identify (especially if you are a
  265. *busy*  node).   This  entire menu is provided so that you can choose which
  266. types of files will be displayed.  Note that a checkmark beside the item in
  267. the menu indicates that the item is enabled.
  268.  
  269.  
  270.                                  NetMail
  271.  
  272. Enables/disables  the display of NetMail files.  These files are identified
  273. by  a filename pattern of #?.pkt in the inbound directory and by a filename
  274. pattern of #?.(pkt|out|cut|dut|hut) in the outbound directory.
  275.  
  276.  
  277.                                  EchoMail
  278.  
  279. Enables/disables   the  display  of  EchoMail  packets.   These  files  are
  280. identified by  a filename pattern of #?.(su|mo|tu|we|th|fr|sa)? in both the
  281. inbound and outbound directories.
  282.  
  283.  
  284.                                 File Lists
  285.  
  286. Enables/disables  the  display  of  file lists (often called "flow" files).
  287. These files are identified by a filename pattern of #?.(flo|clo|dlo|hlo) in
  288. the outbound directory.
  289.  
  290.  
  291.                                File Requests
  292.  
  293. Enables/disables  the  display  of  file  request packets.  These files are
  294. identified  by a filename pattern of #?.(req|rlo) in the outbound directory
  295. and  by  a  filename pattern of #?.(req) in the inbound directory.  (I know
  296. that  a .rlo file is a file list, but it should only exist as the result of
  297. a  file  request,  so you enable it here...  some things are a programmer's
  298. prerogative.)
  299.  
  300.  
  301.                                  Tic Files
  302.  
  303. Enables/disables the display of TIC files.  These files are identified by a
  304. filename pattern of #?.tic in both the inbound and outbound directories.
  305.  
  306.  
  307.                               Temporary Files
  308.  
  309. Enables/disables  the  display  of TrapDoor's temporary files.  These files
  310. are  identified  by  a  filename  pattern  of  TrapTemp#?   in  the inbound
  311. directory.
  312.  
  313.  
  314.                                Unknown Files
  315.  
  316. Enables/disables  the  display  of  otherwise  unidentifiable files.  These
  317. files  are  identified  by  a failure to match any of the filename patterns
  318. that  have  been  described  for the other files.  They are "identified" in
  319. both the inbound and outbound directories.
  320.  
  321.  
  322.  
  323.  
  324. ---------------------------------------------------------------------------
  325.                       The Configuration Options Menu
  326. ---------------------------------------------------------------------------
  327.  
  328.  
  329.                          Display Zero Length Files
  330.  
  331. Enables/disables  the  display  of  files that have a length of zero bytes.
  332. This is provided so that you won't see those mail packets that TrapDoor has
  333. truncated to zero bytes, unless you just want to.
  334.  
  335.  
  336.                           Hijack Screen Titlebar
  337.  
  338. FidoMon  will  always  cycle some information in the screen's titlebar when
  339. its  window  is active.  The "Hijack Screen Titlebar" option allows FidoMon
  340. to  "Hijack"  the screen title from *any* active window that resides on the
  341. same screen as FidoMon.  In other words, if you activate TrapDoor's window,
  342. you'll  still  see FidoMon's cycling inbound/outbound directory information
  343. in  the  screen's  title  bar (this may take several seconds to take effect
  344. after  activating a new window).  If you do not enable Hijack, FidoMon will
  345. only cycle the screen's title when its own window is active.
  346.  
  347. NOTE:   FidoMon will clear the screentitles of all the windows on FidoMon's
  348. screen,  if Hijack is enabled when you exit FidoMon.  This is a good thing!
  349. If  this wasn't done, the screen's title would point to a part of FidoMon's
  350. memory  that  will  not  exist after FidoMon exits.  This can result in the
  351. titlebar displaying garbage.
  352.  
  353. BTW,  I hope to add some more info to the screen's title bar in the future.
  354. Let  me  know,  if there's anything in particular that you'd like for me to
  355. put there (other than an advertisement for your BBS :).
  356.  
  357. Also,  note  that  the file totals that are shown in the screen's title bar
  358. are  for  *all*  files  in  inbound  and outbound - not just those that are
  359. actually enabled or indentfied by TrapDoor or FidoMon.
  360.  
  361.  
  362.                           Quiet Window at Startup
  363.  
  364. This  is  a  configuration option that affects FidoMon only when it starts.
  365. When  this  is  enabled,  FidoMon will not activate its window or bring its
  366. screen  to  the front whenever it starts.  Of course, you must save the set
  367. up for this to ever have any effect.
  368.  
  369.  
  370.                                Inbound Path
  371.  
  372. This  item  enables  you to pick a new path to your Inbound directory.  The
  373. contents of the directory that you choose here will be displayed in the top
  374. half of FidoMon's window.
  375.  
  376.  
  377.                                Outbound Path
  378.  
  379. This  item  enables you to pick a new path to your Outbound directory.  The
  380. contents  of  the  directory  that you choose here will be displayed in the
  381. bottom half of FidoMon's window.
  382.  
  383.  
  384.                                NodeList Path
  385.  
  386. This item enables you to pick a new path to your NodeList's directory.  The
  387. NodeList is used when you select "Info" after clicking on a file.
  388.  
  389.  
  390.                               External Viewer
  391.  
  392. This  item  enables  you  to  select  your  favorite  external text viewer.
  393. Currently, this string defaults to:
  394.  
  395. Run sys:utilities/more %s
  396.  
  397. Note:  the  "%s"  indicates  where  in  the  string FidoMon is to place the
  398. filename  of  the temporary information file that it creates.  In addition,
  399. if  you  place a second "%s" within the string, FidoMon will place the name
  400. of its public screen at that location in the string (see below for examples
  401. of %s placement in other strings).
  402.  
  403.  
  404.                               External Editor
  405.  
  406. This  item  enables you to select your favorite external ASCII text editor.
  407. Currently, this string defaults to:
  408.  
  409. Run c:Ed %s WINDOW "CON:10/0/-1/-1/Edit Me/SCREEN %s"
  410.  
  411. Note:  the first "%s" indicates where in the string FidoMon is to place the
  412. filename  of  the  temporary edit file that it creates.  The second "%s" in
  413. the  string,  indicates  where  FidoMon  is to place the name of its public
  414. screen  (this  is done so that the window will appear on the same screen as
  415. FidoMon).
  416.  
  417.  
  418.                               External Dialer
  419.  
  420. This  item enables you to select your favorite external TrapDoor dialer (or
  421. calling script).  Currently, this string defaults to:
  422.  
  423. Run rexx:rx call.rx %s <>"CON:168/60/390/80/Call Window/SCREEN %s"
  424.  
  425. Note:  the first "%s" indicates where in the string FidoMon is to place the
  426. filename  of  the  temporary edit file that it creates.  The second "%s" in
  427. the  string,  indicates  where  FidoMon  is to place the name of its public
  428. screen.
  429.  
  430.  
  431.                                Task Priority
  432.  
  433. This  item  allows  you  to  easily  set FidoMon's task priority.  I highly
  434. recommend  that  you never set this to anything higher than TrapDoor's task
  435. priority  (you  may  run the risk of causing transfer problems, otherwise).
  436. The  task  priority  defaults  to  -2,  and  this  works  just fine for me.
  437. However,  if  you  are  running many CPU intensive tasks, you *may* want to
  438. raise this just a bit.
  439.  
  440.  
  441.  
  442. ---------------------------------------------------------------------------
  443.                                   Enjoy!
  444.               Elton VonCannon, author of FidoMon and TDClick.
  445. ---------------------------------------------------------------------------
  446.  
  447.  
  448. I can be reached at:
  449.  
  450.                   FidoNet:     1:3648/101.2
  451.  
  452.                   Postal Mail: Elton VonCannon
  453.                                919 Macon St.
  454.                                Asheboro, NC
  455.                                        27203
  456.  
  457.  
  458.  
  459. ---------------------------------------------------------------------------
  460.  
  461. TrapDoor  and  TrapList.library  are  copyrighted by Maximilian Hantsch and
  462. Martin Laubach
  463.  
  464. ReqTools is copyrighted by Nico Francois
  465.  
  466. AmigaDos is still copyrighted by Commodore (as far as I know...)
  467.  
  468. ---------------------------------------------------------------------------
  469.